home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-desktop-9.10-i386-PL.iso / casper / filesystem.squashfs / usr / share / doc / apt-xapian-index / README < prev   
Encoding:
Text File  |  2008-04-23  |  2.1 KB  |  58 lines
  1. Repo:
  2.   git://git.debian.org/git/collab-maint/apt-xapian-index.git
  3.   http://git.debian.org/?p=collab-maint/apt-xapian-index.git
  4.  
  5. Idea:
  6.  - Many data sources each maintain their own data, but provide a plugin to
  7.    index that data in a single, big Xapian database.
  8.  - Every data source has its own db (possibly easy to read plaintext) in
  9.    /var/lib/somewhere
  10.  - Every data source has a tool to keep their own db up to date (e.g.
  11.    downloading new data from the net, or whatever)
  12.  - Every data source installs a plugin in /usr/share/apt-xapian/index/plugins
  13.    that adds information from the data source into Xapian documents during
  14.    indexing
  15.  
  16. Technicalities:
  17.  - There is a central update procedure, but it is fed enough data to do
  18.    differential updates when xapian will make it faster to do so
  19.  - Next to the database there is a README file with information about how the
  20.    index is built and how it can be queried.  Every indexing plugin adds
  21.    information to this README
  22.  - Xapian values are looked up by index.  Indexes are given names using a
  23.    configuration file in the style of /etc/services, located at
  24.    /etc/apt/xapian-index-values.conf
  25.  
  26. Writing a plugin:
  27.  - Take a look at plugins/template.py: it contains all the methods and full
  28.    documentations on what they should do.
  29.  - Take a look at the other plugins for examples: there are many of them.
  30.  
  31. Packages with Xapian bindings that can be uses for querying the database:
  32.  - C++: libxapian-dev
  33.  - Perl: libsearch-xapian-perl
  34.  - Ruby: libxapian-ruby1.8
  35.  - Python: python-xapian
  36.  - Tcl: tclxapian
  37.  - PHP: php5-xapian
  38.  
  39.  The C++ API documentation is in the package xapian-doc.  The documentation of
  40.  the other languages is in the same package as the bindings.
  41.  
  42.  Examples can be found in xapian-examples, as well as in apt-xapian-index.
  43.  
  44.  Some low-level tools to access the database can be found in xapian-tools.
  45.  
  46.  Please see http://www.xapian.org and http://www.xapian.org/docs/
  47.  
  48.  
  49. To do:
  50.  - Example queries
  51.  - Example scripts
  52.  - Document libept transition
  53.  
  54.  - Libept transition
  55.  - Move the debtags plugin in the debtags package
  56.  - Popcon data source
  57.  - Iterating data source
  58.